home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / utilities / misc / tstpubscr.lha / tstpubscr.doc < prev    next >
Encoding:
Text File  |  1992-09-02  |  4.4 KB  |  108 lines
  1.  
  2.                     TstPubScr V1.00 DOCUMENTATION FILE
  3.                     ----------------------------------
  4.  
  5.              (w)6.3.1995 by Hans Bühler, Codex Design Software
  6.  
  7.  
  8.                       I: Everything you have to know
  9.  
  10.  Copyright
  11.  
  12.  Nothing is copyrighted in here.
  13.  Program freeware, source free, docs free.
  14.  
  15.  Disclaimer
  16.  
  17.  You will use this program on your very own risk !
  18.  No gurantee is taken that nothing will cause loss of data or damage
  19.  to your machine.
  20.  
  21.                                II: TstPubScr
  22.  
  23.  Introduction
  24.  
  25.  This program has a fairly simple job to do: Just find out whether a
  26.  give public screen name is known to the system or not.
  27.  I need this program, because I use a MultiView-Batch (to have a look
  28.  at some guides) both from my editor's public screen (CygnusEdScreen1)
  29.  and from the Workbench (default public screen).
  30.  I wanted to be able to invoke that script from CED either from its own
  31.  screen or from the publlic screen its been opened on (Workbench).
  32.  
  33.  Thus, I needed a program returning RETURN_WARN == 5 if a public screen
  34.  is not been found or RETURN_OK == 0 if everything is well.
  35.  
  36.  Parameters
  37.  
  38.  Once you type "tstpubscr ?" you'll be prompted to:
  39.  
  40.  PUBSCRNAME,FORMAT/K,DEFAULT/S,FORCE/S,BATCH/S,LOCK=UNLOCK/S:
  41.  
  42.  if you type in nothing, a short list of all public screens known to your
  43.  system will be printed out.
  44.  
  45.  PUBSCREENNAME=<name> : if you give me a <name>, tstpubscr will try to lock
  46.                         that public screen <name> and will return its name
  47.                         to stdout, if found. In other cases it will return
  48.                         "" to indicate the default publicscreen name.
  49.                         Send this output to a local environment variable to
  50.                         open your thing on the screen found for you.
  51.                         If the desired screen had been found, the prog will
  52.                         return RETURN_OK == 0, otherwise it will return
  53.                         RETURN_WARN == 5 whereby you can check this level by
  54.                         a simple IF command.
  55.  FORMAT=<pattern>     : Is used to specify the output mode of tstpubscr.
  56.                         Normally, it prints out the name "<name>" (quoted!).
  57.                         You may change this (to create script files or
  58.                         something). Use '%s' to be replaced by the screen's
  59.                         name.
  60.                         Does also work in addition to the list mode.
  61.  DEFAULT              : Useless at all. Does always return "". One thing is
  62.                         that it checks whether there is any default public
  63.                         screen (RETURN_ERROR).
  64.  FORCE                : Permits tstpubscr to return the default public screens
  65.                         name when the one specified by you is not been found.
  66.  BATCH                : Surpress all additional output.
  67.                         Made for use in batch scripts (check out
  68.                         'tstpubscr' and 'tstpubscr BATCH' on the other hand !).
  69.  LOCK / UNLOCK        : Commands tstpubscr to keep a lock on the screen found
  70.                         (or on the default one, if FORCE is NOT used).
  71.                         You have to unlock this screen, if you've finished work
  72.                         (e.g. if you have opened the window you were out to
  73.                         open).
  74.                         To unlock a screen, use the same commandline (so the
  75.                         prog will be able to find the screen you mean) and
  76.                         replace LOCK by UNLOCK. Note: De facto, LOCK and UNLOCK
  77.                         are the same. A second LOCK on a screen will unlock it!
  78.                         Note 2: tstpubscr will remember the screen(s) having
  79.                         been locked by adding a msgport to the system's port-
  80.                         list. DO NOT REMOVE THESE PORTS ! IT'S tstpubscr's
  81.                         TASK TO DO SO !!!!!!!!!!
  82.  
  83.  Example
  84.  
  85.  You want to run Multiview on a publicscreen 'CygnusEdScreen1' or on the
  86.  Workbench, if CED is not active or using the Workbench-screen:
  87.  
  88. {
  89.  echo >ram:dummy NOLINE "run >NIL: multiview >NIL: <NIL: FILE=HELPDIR:file
  90.                          PUBSCREEN="
  91.  tstpubscr >>ram:dummy CygnusEdScreen1 BATCH
  92.  execute ram:dummy
  93.  delete ran:dummy
  94. }
  95.  
  96.  Or anything else...
  97.  
  98.                                 III: See ya
  99.  
  100.  Okay, bye,bye and have nice future.
  101.  
  102.  Contact me if you want:
  103.  
  104.  e-mail  h0348kil@rz.hu-berlin.de
  105.  phone   ++49 (0)30 3963374
  106.  scripts Hans Bühler, Emdener Strasse 48, 10551 Berlin, Germany
  107.  
  108.